home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / textbuf.arc / TEXTBUF.DOC < prev   
Text File  |  1988-06-02  |  20KB  |  517 lines

  1.                           *****   TextBuf   *****
  2.                                 Version 1.1
  3.  
  4.                   Copyright (c) 1985,1986 by Gary Chapman
  5.                            All rights reserved
  6.  
  7.              ******************************************************
  8.              TextBuf is "User-Supported Software".  If you use this
  9.              software, a contribution of 25 dollars would be appre-
  10.              ciated.  Send to
  11.  
  12.                              Gary Chapman
  13.                              484 Seventh Street #1
  14.                              Brooklyn, New York 11215
  15.  
  16.              Please feel free to duplicate and distribute this
  17.              software (although NOT for profit) to other PC users.
  18.              ******************************************************
  19.  
  20.  
  21.                                   Contents
  22.                    *************************************
  23.                    About TextBuf
  24.  
  25.                    About This Manual
  26.  
  27.                    Hardware Requirements
  28.                    Software Requirements
  29.                    TextBuf  Restrictions
  30.  
  31.                    How TextBuf Works
  32.  
  33.                    Configuring Your Disks
  34.  
  35.                    How to Use TextBuf
  36.                    Loading TextBuf
  37.                    Quitting TextBuf
  38.                    TextBuf Commands
  39.  
  40.                    A Sample TextBuf Session
  41.  
  42.                    The Startkey Utility Program
  43.  
  44.                    Error Messages
  45.                    *************************************
  46.  
  47.  
  48. About TextBuf
  49. *************
  50.  
  51. TextBuf is a program which augments the other software you use. It allows you
  52. to:
  53.  
  54.      -> select text from your screen and save it in memory;
  55.      -> edit that text, if you wish; and later
  56.      -> paste that text directly into another program.
  57.  
  58. The idea is akin to the "cut-and-paste" operation which is part of most
  59. wordprocessing programs.  With TextBuf, however, it's really "copy-and-paste",
  60. since no text is actually "cut" (i.e. deleted).
  61.  
  62. For example, a column of numbers from a spreadsheet can easily be transfered
  63. into a word processing document.  Or you can store text which you see on your
  64. screen during a communications session; later you can insert that information
  65. into a database or a wordprocessing document.
  66.  
  67. You can also use all of TextBuf's features within a single program (e.g., to
  68. retain text which you want to use later).
  69.  
  70. Unlike some programs which offer primitive "copy-and-paste" facilities, TextBuf
  71. provides you with an assortment of features for setting the copying and pasting
  72. options to your own preferences.  TextBuf allows you to:
  73.  
  74.      -> select columns of text (important for spreadsheet applications)
  75.      -> select non-adjacent sections of text from your screen
  76.      -> paste text all at once or a "line at a time"
  77.      -> save in succession a number of text selections from the screen
  78.      -> edit text that you have saved
  79.      -> print the saved text
  80.      -> use the "text buffer" as a simple word processor for short documents.
  81.  
  82.  
  83. About this Manual
  84. *****************
  85.  
  86. This manual gives instructions for using TextBuf on your personal computer.  It
  87. begins with a description of how TextBuf works, then tells you how to start the
  88. program on your machine, and finally describes each TextBuf command or option.
  89.  
  90. It is assumed that you have a basic familiarity with the PC and the DOS
  91. operating system.
  92.  
  93.  
  94. Hardware Requirements
  95. *********************
  96.  
  97. To use TextBuf, you should have an IBM PC (PC/XT/AT) or close compatible
  98. running PC- or MS-DOS (version 2.0 or higher) and containing a minimum of 256Kb
  99. of RAM memory.  Since TextBuf itself uses approximately 34Kb of RAM, you must
  100. have sufficent memory to accomodate your operating system (approximately 20Kb),
  101. TextBuf, and whatever application program you wish to run.
  102.  
  103.  
  104. Software Requirements
  105. *********************
  106.  
  107. You must also be using text-oriented software on your PC, such as most
  108. wordprocessing, spreadsheet, database, and communications programs.  Although
  109. TextBuf will not function when your PC is producing graphics, it will not
  110. interfere with the operation of such programs.
  111.  
  112.  
  113. TextBuf Restrictions
  114. ********************
  115.  
  116. TestBuf can store a maximum of 4000 characters in its text buffer, enough for
  117. two completely full screens of text.
  118.  
  119. You must load TextBuf before running your own PC software; do not try to run
  120. TextBuf from "within" another program.
  121.  
  122. TextBuf may or may not work in conjunction with certain PC software packages
  123. which take direct, very low-level, control of the computer.  For example, other
  124. "resident" software packages may conflict with TextBuf.
  125.  
  126.  
  127. How TextBuf Works
  128. *****************
  129.  
  130. TextBuf must be installed before you run your other software.  It then waits in
  131. the background until you press a special sequence of keys to "wake it up" and
  132. use one of its features.
  133.  
  134. After TextBuf is loaded, it looks at each of your keystrokes to see if you are
  135. calling upon it.  If not, the keys you press are passed along to your main
  136. application program (just as if TextBuf were not present):
  137.  
  138. If you press the special "start keys", however, TextBuf knows that you wish to
  139. use one of its commands for saving, pasting, editing, or printing text.
  140.  
  141. Say that you give the command to select text from the screen.  TextBuf takes
  142. direct control of your screen, allows you to select the text you desire, and
  143. then stores that text in a reserved area of memory we call the text buffer:
  144.  
  145. Later, if you then tell TextBuf to "paste" the saved text into your main
  146. application, it takes characters from the text buffer (instead of from the
  147. keyboard) and reports them to your application program, just as if you had
  148. typed them on the keyboard:
  149.  
  150. In each case, after you are done with a TextBuf function, control of the
  151. computer is returned to your main application.
  152.  
  153.  
  154. Configuring Your Disks
  155. **********************
  156.  
  157. Normally, in order to use TextBuf, it will be most convenient if you load
  158. TextBuf into memory when you first start your computer.  You should therefore
  159. put a copy of the TextBuf program on any disks you use to "boot" your system.
  160.  
  161.  
  162. How to Use TextBuf
  163. ******************
  164.  
  165. You begin by loading TextBuf into memory before running your main application
  166. (e.g. a word processor, spreadsheet, etc).  Later, when you wish to use
  167. TextBuf, you press its special start keys.  At that point, TextBuf's various
  168. commands (invoked by pressing function keys) become available to you.
  169.  
  170. The "factory-set" start keys for TextBuf are
  171.  
  172.                                  Alt  Z
  173.  
  174. although you may change this default setting if Alt Z is used by one of more of
  175. your other applications (see the section below on the Startkey utility
  176. program).
  177.  
  178. Please note: to use Alt Z, press down the "Alt" and "Z" keys simultaneously.
  179.  
  180.  
  181. Loading TextBuf
  182. ***************
  183.  
  184. To load the TextBuf program, first be sure you are in a disk directory which
  185. contains the file "TEXTBUF.COM"  (the root directory of drive A, or drive C if
  186. you have a hard disk). Then run the program by typing the command:
  187.  
  188.                                  textbuf
  189.  
  190. followed by a carriage return.  You should see a message on your screen with
  191. the name of the program and a copyright notice.  If, on the other hand, you see
  192. an error message, there has been a problem in loading TextBuf (see the section
  193. below on Error Messages).
  194.  
  195. Assuming that you have encountered no problem, TextBuf is now loaded into
  196. memory and is waiting for you to "wake it up" by pressing the Alt Z key
  197. combination.
  198.  
  199.  
  200. Quitting TextBuf
  201. ****************
  202.  
  203. Once Textbuf is installed, you can only remove it from your system by
  204. rebooting the computer (by pressing Ctrl-Alt-Del), or by turning the machine
  205. off and then on again. You need do this only if you find that, with Textbuf
  206. installed, you have insufficient memory to run an application program.
  207.  
  208.  
  209. TextBuf Commands
  210. ****************
  211.  
  212. In order to use one of TextBuf's functions, you must first press the start keys
  213. (Alt Z, unless you change it with the Startkey program).  You can then give a
  214. specific Textbuf command depending upon what you wish to do.
  215.  
  216. After pressing Alt Z, you can do the following:
  217.  
  218.  
  219. F1 --  Select
  220. *************
  221.  
  222. The Select command lets you choose what text on your screen you wish to save.
  223. Use the cursor arrow keys to move to the location on your screen where you wish
  224. to begin the selection; then press F1 again if you wish to begin "normal"
  225. selection of text lines, or press F2 if you wish to begin selecting a "column"
  226. of text.
  227.  
  228. As you move the cursor, selected text will be highlighted on your screen.  If,
  229. however, you press F1 or F2 again, your previous selection will be cancelled
  230. and the current cursor location will be taken as the beginning point for
  231. subsequent selection.
  232.  
  233. With TextBuf you can make "disjoint" selections of text.  For example, you can
  234. select a column of text on the left-hand side of your screen; you can then move
  235. the cursor over to the far right-hand side of your screen and select another
  236. column of text.  The procedure is as follows:
  237.  
  238.      Press Alt Z to start TextBuf.
  239.  
  240.      Press F1  (the Select command).
  241.  
  242.      Move the cursor to the first location where you wish to begin a
  243.      selection, and press F1 or F2 (for normal or column selection).
  244.  
  245.      Move the cursor, selecting text as you go.
  246.  
  247.      If you wish to stop the current selection, and wish to move to a
  248.      different region of the screen for a second selection, hold down the
  249.      Ctrl key on your keyboard and use one of the following keys to move the
  250.      cursor:
  251.  
  252.                         Direction Key
  253.  
  254.                         Up                Home
  255.                         Down              End
  256.                         Left              Left arrow
  257.                         Right             Right arrow
  258.  
  259.  
  260.      Let go of the Ctrl key when you reach the location where you wish to resume
  261.      selecting text.
  262.  
  263.      Use the cursor arrow keys to select additional text in the new location.
  264.  
  265.      When you have finished selecting text, press the F10 key to exit and
  266.      return to your normal application.  You may subsequently examine the
  267.      text you have saved by using the F5 (Show) command.
  268.  
  269.  
  270. F2 --  Paste
  271. ************
  272.  
  273. The Paste command lets you insert saved text into your current main
  274. application.  When you are ready to paste text, move your cursor to the
  275. location on your screen where you intend text to be inserted.  Then press Alt Z
  276. followed by F2.  You will see text being inserted rapidly.
  277.  
  278. Remember that pasting text from the text buffer is exactly like typing the
  279. characters in at the keyboard.  Do not attempt to paste text at a point in your
  280. main program which is inappropriate for keyboard input.  If you observe a
  281. problem in pasting text, or if you make a mistake and give the paste command at
  282. the wrong moment, you can cancel the paste operation by pressing any key on
  283. your keyboard.
  284.  
  285. There are several options pertaining to pasting text which you can change.  See
  286. the description below of the Options command (F8).
  287.  
  288.  
  289. F3 -- Append
  290. ************
  291.  
  292. The Append command works exactly like the Select (F1) command described above,
  293. with the exception that any text you select does not replace the previous
  294. contents of the text buffer, but rather is appended to it.
  295.  
  296. The maximum number of characters which the text buffer can hold is 4000
  297. (including carriage returns at the end of each line).  If you repeatedly append
  298. new text to the end of the text buffer, eventually you will see a message from
  299. TextBuf informing you that the buffer is full!
  300.  
  301.  
  302. F4 -- Zap
  303. *********
  304.  
  305. The Zap command transfers the precise contents of your current screen to the
  306. text buffer, without your needing to select the text.  This is the quickest way
  307. to "capture" the contents of your screen.
  308.  
  309. Before pasting such text into another application, or before printing it, you
  310. may with to edit (or delete) some of the text (see the Show command below).
  311.  
  312. Zap, combined with the TextBuf Print command, gives you the same capability as
  313. the PC's Shift-PrtSc key combination which prints the current contents of the
  314. screen. TextBuf, however, offers you the additional option of easily making
  315. small changes or deletions to the screen before printing.
  316.  
  317.  
  318. F5 -- Show
  319. **********
  320.  
  321. The Show command allows you to examine, and to edit, the contents of the text
  322. buffer. If you type characters at the cursor location, the keys you press will
  323. "write over" the displayed text.
  324.  
  325. Each line in the text buffer ends with an "invisible" carriage return; you can
  326. only change text on each line up to this point.
  327.  
  328. At the bottom of the text buffer screen, you will see a highlighted "status
  329. line".  This line tells you whether there is "More ..." text in the buffer than
  330. can be displayed on the screen at one time (use the cursor arrow keys to scroll
  331. down), the number of characters saved in the text buffer (not including
  332. carriage returns), and what pasting options have been set (see the section
  333. below on the Configure command.)
  334.  
  335. Press F10 to exit the text buffer and return to your main application.
  336.  
  337.  
  338. F6 -- Note Pad
  339. **************
  340.  
  341. The F6 command erases any text which is stored in the text buffer and converts
  342. the buffer for use as a "single-page" note pad.  You can type text anywhere you
  343. wish on the screen, and later print or paste that text.
  344.  
  345. Use the cursor arrow keys to move around the screen;  the Del key will erase
  346. the character located before the cursor; pressing the space bar will erase the
  347. character at the cursor location.
  348.  
  349. Note that the simple word processor thus provided by the Note Pad command is
  350. always in "over-write" mode.
  351.  
  352. Press F10 to exit the Note Pad and return to your main application.
  353.  
  354.  
  355. F7 -- Print
  356. ***********
  357.  
  358. The Print command will print text saved in the text buffer; if your printer is
  359. not "on-line", however, you will see an error message when you give this
  360. command.
  361.  
  362. Warning: during printing, the TextBuf's print function does not continue to
  363. check for "out-of-paper" or "off-line" conditions.  Try to make sure, before
  364. beginning to print, that your printer has sufficient paper to print the contents
  365. of the text buffer (a single page of paper will usually sufice).
  366.  
  367.  
  368. F8 -- Options
  369. *************
  370.  
  371. There are four factors pertaining to "pasting" text which you can alter with
  372. the Options command:
  373.  
  374. 1.  Include a Carriage Return at the end of each line pasted?            (CR)
  375. 2.  Paste "Leading Blanks" at the beginning of each line pasted?         (LB)
  376. 3.  Paste the entire text buffer, or just Paste a single Line at a time? (PL)
  377. 4.  Paste a "Down Arrow" keystroke at the end of each line pasted?             (DA)
  378.  
  379. (An abbreviation for each of these options is given in parentheses; the "status
  380. line" in the text buffer shows which of these options have been "turned on".)
  381.  
  382. Experimentation with these options will show you which are best for you in
  383. different situations.  For example, if you "select" a column of numbers from a
  384. wordprocessing document, and wish later to paste these numbers into a
  385. spreadhseet, you may prefer (or not depending upon your spreadsheet) to end
  386. each line (each number) with a carriage return and/or a down-arrow keystroke.
  387. In such a situation, you may also not wish to include "leading blanks" before
  388. pasting each number into the spreadsheet.
  389.  
  390. Alternatively, if your text buffer contains a column of numbers which you are
  391. going to paste into a wordprocessing document, you may wish to paste a few
  392. numbers in one location, and the rest in another.  For this purpose, you may
  393. want to paste one line at a time, changing your pasting location as
  394. appropriate.
  395.  
  396. When you are "pasting one line at a time", the next line to be pasted will be
  397. highlighted if you examine the text buffer with the Show (F5) command.
  398.  
  399.  
  400. F9 -- Help
  401. **********
  402.  
  403. Pressing the Help key during TextBuf operation will provide you with a brief
  404. reminder of your current options.  You can exit from this help facility by
  405. pressing one of the keys which the help suggests, or by pressing the Exit key
  406. (F10).
  407.  
  408.  
  409. F10 -- Exit
  410. ***********
  411.  
  412. When you are using TextBuf (e.g. when you are selecting text or examing the
  413. text buffer), pressing the F10 key will return you to your main application
  414. program.
  415.  
  416.  
  417. A Sample TextBuf Session
  418. ************************
  419.  
  420. If you wish to give TextBuf a quick tryout, follow these steps:
  421.  
  422.      -> Start up your computer as usual.
  423.  
  424.      -> Start TextBuf by giving the command:  'textbuf'.
  425.  
  426.      -> Start an application program, preferably a word processor for learning
  427.         purposes, and put some information on the screen.
  428.  
  429.      -> Press Alt Z to invoke TextBuf.
  430.  
  431.      -> Press F1 to pick the Select command.
  432.  
  433.      -> Use the cursor arrow keys to move to some spot on the screen.
  434.  
  435.      -> Press F2 to indicate you wish to begin a "column" selection.
  436.  
  437.      -> Move the cursor with the arrow keys to the left or right, up or down;
  438.         text will be highlighted as you go.
  439.  
  440.      -> Press F10 to end the selection process and return to your main
  441.         application.
  442.  
  443.      -> Press Alt Z followed by F5 to examine the contents of the text buffer.
  444.  
  445.      -> The screen should clear and you should see the text which you selected.
  446.  
  447.      -> Press F10 to exit from the text buffer.
  448.  
  449.      -> To paste your text, move to a location in your main application where
  450.         it would be appropriate for you to actually type in the text which you
  451.         stored in the text buffer.
  452.  
  453.      -> Press Alt Z followed by F2 to begin pasting.  If you wish to abort the
  454.         paste operation, press any key on the keyboard.
  455.  
  456.  
  457. The Startkey Utility Program
  458. ****************************
  459.  
  460. Startkey is a utility program which comes with TextBuf.  It allows you to
  461. choose what keys you will press to "start" TextBuf.  The "default" setting is
  462.  
  463.                                  Alt Z
  464.  
  465. as described above.  There may be a problem, however, with this setting if one
  466. or more of the programs you normally use has defined "Alt Z" as one of its
  467. commands.
  468.  
  469. Actually, TextBuf has been cleverly designed so that if you press Alt Z twice
  470. in a row, TextBuf will ignore the command, and your main application software
  471. will "see" your Alt Z keystroke.
  472.  
  473. You may, however, wish to change Alt Z to some other key combination.  To do
  474. this, run the Startkey program by giving the following command at the DOS
  475. prompt:
  476.  
  477.                                startkey
  478.  
  479. You will see instructions and a description of the various possible keystroke
  480. combinations which you may designate as the as the "start keys" for TextBuf.
  481.  
  482. The next time you load TextBuf, your new "start keys" will take effect.
  483.  
  484.  
  485. Error Messages
  486. **************
  487.  
  488. TextBuf contains the following error messages:
  489.  
  490.  
  491.      -> TextBuf cannot be installed!
  492.  
  493. You will see this message if you try to install TextBuf more than once on your
  494. computer, or if you have previously loaded certain other resident utility
  495. programs which utilize the same DOS interrupt which TextBuf wishes to reserve
  496. for its own use.
  497.  
  498.  
  499.      -> Text Buffer Empty!
  500.  
  501. This message appears if you give the paste (F2) or print (F7) commands and your
  502. text buffer is empty.
  503.  
  504.  
  505.      -> Text Buffer Full!
  506.  
  507. If you attempt to append text to a "full" text buffer, you will see this
  508. message.
  509.  
  510.  
  511.      -> Printer Not Available!
  512.  
  513. If you give the print (F8) command and your printer is turned off, is set
  514. "off-line", or is "out of paper", you will see this message.
  515.  
  516.  
  517.